Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add VSCode extension documentation #20385

Merged
merged 25 commits into from
Nov 26, 2024
Merged

Add VSCode extension documentation #20385

merged 25 commits into from
Nov 26, 2024

Conversation

tedks
Copy link
Contributor

@tedks tedks commented Nov 22, 2024

Description

  • Guides:
    • Mentioning all of these on the sui-install page, as a new section called "Install Sui developer tools"
    • Updating the dev-cheat-sheet
  • References:
    • Documentation of all the Move LSP features and how to use them
    • Documentation of all the debugger features and how to use them

Test plan

How did you test the new or updated feature?

  • Manual inspection of docs

Release notes

Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.

For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.

  • Protocol:
  • Nodes (Validators and Full nodes):
  • Indexer:
  • JSON-RPC:
  • GraphQL:
  • CLI:
  • Rust SDK:
  • REST API:

@vercel Vercel
Copy link

vercel bot commented Nov 22, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sui-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 26, 2024 10:46pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Nov 26, 2024 10:46pm
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Nov 26, 2024 10:46pm
sui-typescript-docs ⬜️ Ignored (Inspect) Visit Preview Nov 26, 2024 10:46pm

@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 03:18 — with GitHub Actions Inactive
@github-actions github-actions bot added the Type: Documentation Improvements or additions to documentation label Nov 22, 2024
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:04 — with GitHub Actions Inactive
ronny-mysten
ronny-mysten reviewed Nov 22, 2024
View reviewed changes
Copy link
Contributor

@ronny-mysten ronny-mysten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! The docs/sidebars/references.js file needs to be updated to include the new pages, as well. Puts the pages on left nav.

docs/content/guides/developer/getting-started/sui-install.mdx Outdated Show resolved Hide resolved
docs/content/references/cli/cheatsheet.mdx Outdated Show resolved Hide resolved
docs/content/references/ide/debugger.mdx Show resolved Hide resolved
docs/content/references/ide/debugger.mdx Outdated Show resolved Hide resolved
docs/content/references/ide/debugger.mdx Outdated Show resolved Hide resolved
docs/content/references/ide/move.mdx Outdated Show resolved Hide resolved
docs/content/references/ide/move.mdx Outdated Show resolved Hide resolved
docs/content/references/ide/move.mdx Outdated Show resolved Hide resolved
docs/content/references/ide/move.mdx Outdated Show resolved Hide resolved
docs/content/references/ide/move.mdx Outdated Show resolved Hide resolved
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:11 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:12 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:12 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:13 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:14 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:14 — with GitHub Actions Inactive
@tedks @ronny-mysten
Markup for goto def
9e1e093 
Co-authored-by: ronny-mysten <[email protected]>
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:15 — with GitHub Actions Inactive
@tedks @ronny-mysten
Less technical section name
935f11b 
Co-authored-by: ronny-mysten <[email protected]>
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:24 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:32 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:33 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:34 — with GitHub Actions Inactive
@tedks @ronny-mysten
Various cleanups
bfb4f91 
Co-authored-by: ronny-mysten <[email protected]>
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:35 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:38 — with GitHub Actions Inactive
@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 22, 2024 17:41 — with GitHub Actions Inactive
tzakian
tzakian reviewed Nov 22, 2024
View reviewed changes
docs/content/references/ide/move.mdx Outdated
```bash
cargo install --git https://github.com/MystenLabs/sui.git sui-move-lsp
```
By default, the Move extension expects to find the `move-analyzer` binary in `~/.sui/bin`. You can either copy the binary here, or configure the extension to use a different path.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to worry about specifying the location for windows users? I'm guessing not since the only way they can install it is with choco I'm guessing?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is also the path on Windows, just interpolate ~ with %HOMEDIR% or whatever it is. By default this is at C:\Users\%USERNAME%\.sui\bin, but that could change based on your home drive.

docs/content/references/ide/debugger.mdx Outdated

![Stepping through code execution](./images/debugger_running.png)

Move Trace Debugger supports standard debugging features like step over, step into, step out, continue, and stop. You can step through normal code, and also Move macros.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we have a disclaimer here (or maybe we have a more general one elsewhere) that e.g., macros are supported, but are a known pain point that we are working on improving still.

ronny-mysten
ronny-mysten approved these changes Nov 22, 2024
View reviewed changes
Copy link
Contributor

@ronny-mysten ronny-mysten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving to carry forward after addressing any other comments

@tedks tedks temporarily deployed to sui-typescript-aws-kms-test-env November 26, 2024 16:15 — with GitHub Actions Inactive
@ronny-mysten ronny-mysten temporarily deployed to sui-typescript-aws-kms-test-env November 26, 2024 22:44 — with GitHub Actions Inactive
@tedks tedks merged commit 37f15b1 into main Nov 26, 2024
55 checks passed
@tedks tedks deleted the tedks/ide-docs branch November 26, 2024 23:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tzakian tzakian tzakian left review comments

@ronny-mysten ronny-mysten ronny-mysten approved these changes

@awelc awelc Awaiting requested review from awelc

Assignees
No one assigned
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tedks @tzakian @ronny-mysten